Improve wording of lsh docstring
authorStefan Kangas <stefankangas@gmail.com>
Sat, 22 Feb 2025 17:15:37 +0000 (18:15 +0100)
committerStefan Kangas <stefankangas@gmail.com>
Sun, 23 Feb 2025 19:47:34 +0000 (20:47 +0100)
* lisp/subr.el (lsh): Improve wording of docstring.

lisp/subr.el

index 7aca542dab46d0c59701c8fd04465bae77bad86e..7552378a781ee2488dac65757ca7f776ac6aab83 100644 (file)
@@ -571,10 +571,10 @@ If COUNT is negative, shifting is actually to the right.
 In this case, if VALUE is a negative fixnum treat it as unsigned,
 i.e., subtract 2 * `most-negative-fixnum' from VALUE before shifting it.
 
-Most uses of this function turn out to be mistakes.  We recommend
-to use `ash' instead, unless COUNT could ever be negative, and
-if, when COUNT is negative, your program really needs the special
-treatment of negative COUNT provided by this function."
+Most uses of this function turn out to be mistakes.  We recommend using
+`ash' instead, unless COUNT could ever be negative, in which case your
+program should only use this function if it specifically requires the
+special handling of negative COUNT."
   (declare (ftype (function (integer integer) integer))
            (compiler-macro
             (lambda (form)